<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>http::basic_parser::body_limit</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
<link rel="up" href="../boost__beast__http__basic_parser.html" title="http::basic_parser">
<link rel="prev" href="basic_parser0.html" title="http::basic_parser::basic_parser">
<link rel="next" href="chunked.html" title="http::basic_parser::chunked">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_parser0.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_parser.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="chunked.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="beast.ref.boost__beast__http__basic_parser.body_limit"></a><a class="link" href="body_limit.html" title="http::basic_parser::body_limit">http::basic_parser::body_limit</a>
</h5></div></div></div>
<p>
          <a class="indexterm" name="idp108183744"></a>
Set the limit on the payload body.
        </p>
<h6>
<a name="beast.ref.boost__beast__http__basic_parser.body_limit.h0"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.body_limit.synopsis"></a></span><a class="link" href="body_limit.html#beast.ref.boost__beast__http__basic_parser.body_limit.synopsis">Synopsis</a>
        </h6>
<pre class="programlisting"><span class="keyword">void</span>
<span class="identifier">body_limit</span><span class="special">(</span>
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="identifier">v</span><span class="special">);</span>
</pre>
<h6>
<a name="beast.ref.boost__beast__http__basic_parser.body_limit.h1"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.body_limit.description"></a></span><a class="link" href="body_limit.html#beast.ref.boost__beast__http__basic_parser.body_limit.description">Description</a>
        </h6>
<p>
          This function sets the maximum allowed size of the payload body, before
          any encodings except chunked have been removed. Depending on the message
          semantics, one of these cases will apply:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              The Content-Length is specified and exceeds the limit. In this case
              the result <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">body_limit</span></code></a> is returned immediately
              after the header is parsed.
            </li>
<li class="listitem">
              The Content-Length is unspecified and the chunked encoding is not specified
              as the last encoding. In this case the end of message is determined
              by the end of file indicator on the associated stream or input source.
              If a sufficient number of body payload octets are presented to the
              parser to exceed the configured limit, the parse fails with the result
              <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">body_limit</span></code></a>
            </li>
<li class="listitem">
              The Transfer-Encoding specifies the chunked encoding as the last encoding.
              In this case, when the number of payload body octets produced by removing
              the chunked encoding exceeds the configured limit, the parse fails
              with the result <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">body_limit</span></code></a>.
            </li>
</ul></div>
<p>
          Setting the limit after any body octets have been parsed results in undefined
          behavior.
        </p>
<p>
          The default limit is 1MB for requests and 8MB for responses.
        </p>
<h6>
<a name="beast.ref.boost__beast__http__basic_parser.body_limit.h2"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.body_limit.parameters"></a></span><a class="link" href="body_limit.html#beast.ref.boost__beast__http__basic_parser.body_limit.parameters">Parameters</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody><tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">v</span></code>
                  </p>
                </td>
<td>
                  <p>
                    The payload body limit to set
                  </p>
                </td>
</tr></tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2016, 2017 Vinnie Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_parser0.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_parser.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="chunked.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
